CreateEmbeddedFramesIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODPart

CreateEmbeddedFramesIterator
The CreateEmbeddedFramesIterator method should create an embedded-frames iterator to give callers access to all embedded frames of this part.
ODEmbeddedFramesIterator CreateEmbeddedFramesIterator (
                                       in ODFrame frame);
frame
A reference to a display frame whose embedded frames the iterator traverses.
return value
A reference to a new embedded-frames iterator object.

DISCUSSION
Your part's CreateEmbeddedFramesIterator method should create, initialize, and return an embedded-frames iterator. Your part calls this method if it needs to apply an operation to all frames directly embedded within a display frame of another part. It is your responsibility to delete the iterator when it is no longer needed.
While you are using an embedded-frames iterator, you should not modify the list of embedded frames for the part. You must postpone adding items to or removing items from the list of embedded frames for the part until after you have deleted the iterator.

OVERRIDING
When you subclass ODPart, you can override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely. This method needs to be implemented only by container parts.

EXCEPTIONS

kODErrCannotEmbed
This part does not support embedding.
kODErrInvalidFrame
The specified frame is not a display frame of this part.
kODErrOutOfMemory
There is not enough memory to allocate the embedded-frames iterator object.

SEE ALSO
The ODEmbeddedFramesIterator class (page 202).
Table 2-1 on page 89 in OpenDoc Programmer's Guide.
"Providing an Embedded-Frames Iterator" on page 117 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.